home *** CD-ROM | disk | FTP | other *** search
/ Gigarom 4 / Mac Giga-ROM 4.0 - 1993.toast / FILES / BBS / FIRSTCLASS / FC LogScan 1.0.2.cpt / About FC LogScan… next >
Text File  |  1992-03-03  |  7KB  |  138 lines

  1.                                      About FC Logscan…
  2.  
  3. FirstClass LogScan is a utility which analyzes FirstClass daily logs to produce a report in the following format (the report is visible here only if you read this file using TeachText):
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31. Users are listed in the order of their calls to the BBS during the report period. The user list in this report has been abridged for the sake of space.
  32.  
  33. FirstClass LogScan can run either automatically, processing the previous day's log file and putting its report in the FirstClass LogFiles folder, or under user control, processing log files one at a time. In automatic mode, you can set it to write an abbreviated report -- just the top of the full report -- to a folder of your choosing. I use this feature to have it maintain a daily report of board activity in an external file accessible to my users. For this I use QuicKeys to automatically launch it at about 4 a.m. every day.
  34.  
  35. You configure FirstClass LogScan by launching it while holding down the mouse button. When you do so, you will see the following dialog (the dialog is visible here only if you read this file using TeachText):
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53. The first text field holds the path to your FirstClass log files. It should be the same as what's shown except your volume name will be different. To set it properly, click the Find button and show FirstClass LogScan where the folder is.
  54.  
  55. The second text field is the location where you want FirstClass LogScan to put its brief report (use the second Find button to set the path), whose name you set in the third text field.
  56.  
  57. The fourth text field is the creator you would like to use for text files. This is a four-letter resource type which tells the document which parent application to launch if you double click it. Some common creator types are
  58.  
  59. MSWD       Microsoft Word
  60. MACA       MacWrite
  61. EDIT         Edit
  62. QED1        QUED
  63. ttxt          TeachText
  64.  
  65. The next 12 text fields are the numbers of sessions you don't want to include in the report. I have set sessions 3 and 4 to be ignored, since they are network accounts which I don't care about tracking. If you don't want to omit any sessions leave all these fields empty. If you have more than 12 network users you'd like to omit, send me a very pleasant note and I might oblige you. FirstClass numbers its sessions beginning with 0. I believe that network sessions are always the highest numbers in the series-- at least that's how it works on my board.
  66.  
  67. The three check boxes let you set the following:
  68.  
  69. MultiFinder -- enable this check box if you're using MultiFinder or System 7 (or later).
  70.  
  71. Automatic -- enable this check box if you want FirstClass LogScan to run automatically rather than under user control. If you want to use it both ways, use two copies of the utility, one set for Automatic, one not.
  72.  
  73. Brief Report -- if you don't want to create a Brief Report, disable this checkbox.
  74.  
  75. Click the Save button to save your configuration. Cancel discards your changes.
  76.  
  77. When it runs, FirstClass LogScan reads a text file called "LogScan Header" (without the quotes) located at the same directory level as FirstClass LogScan to get the legend for its report. The contents of my LogScan Header file are as follows:
  78.  
  79. Line 1 = (213) 254-4852
  80. Line 2 = (213) 254-4133
  81. Line 3 = MacValley
  82.  
  83. For best results, view with Monaco 9 pt.   X is busy  . is idle
  84.  
  85. Obviously, you want to change your version of this file to reflect your own phone number(s). You can put up to 255 characters in this file. If you put more, only the first 255 characters will be read.
  86.  
  87. In addition to these configuration options, all of FirstClass LogScan's prompts and settings are stored in its STR# resources, so if you're handy with ResEdit you can customize it as you wish.
  88.  
  89. The best way to get everything working is to use a copy of FirstClass LogScan with the Automatic box unchecked. Prepare your LogScan Header file (it must be text, not a formatted word processing document) and run FirstClass LogScan, then check the results.
  90.  
  91. When FirstClass LogScan runs in manual mode, it presents you with a standard file dialog asking you to select a daily log to process. Select a valid FirstClass log file (if you decide to feed it something else it will do strange and messy things, though it won't alter the source file). Then it will ask you where to save its report, using what name. If you answer this in a rational and positive manner, it will analyze the input file and write a report. Then it will ask you for another file to process. Click Cancel when you're ready to quit.
  92.  
  93. When FirstClass LogScan runs in automatic mode it opens the previous day's log file, analyzes it and writes a report with the log name followed by the string " Report" to the FirstClass LogFiles folder. If you've enabled the Brief Report option, it also writes a short version (without the user names) to the location you've selected.
  94.  
  95. The graphic indication of BBS use shows activity in 20-minute divisions. An X indicates a valid session. A period (.) indicates no activity. If a caller logs on for even one minute in a 20-minute period that's enough to mark that time division. So a solid row of Xs does not necessarily mean your board was continuously busy, just that it received at least one call every 20 minutes. A better measure of board activity is in the percentages kept for each line, but the graphic display shows you when your board is busiest.
  96.  
  97. FirstClass LogScan is free, though is is ©1991 by me. If you use it, please send me a nice postcard:
  98.  
  99. Pete Johnson
  100. Glassell Park BBS      (213) 254-4852
  101. Post Office Box 65074
  102. Los Angeles, CA 90065
  103.  
  104. For the incurably curious, here are some notes on the STR# resources in FirstClass LogScan (the program substitutes appropriate data into the lines which contain ^0, ^1, ^2 etc.) :
  105.  
  106. STR# 128 holds report settings as follows:
  107.     #1  two-character string with Call symbol and NoCall symbol
  108.     #2  title string: BBS activity from ^0 to ^1      
  109.     #3  summary: ^0 Graphic Interface calls, ^1 Command Line Interface calls, ^2 total
  110.     #4   Header file name  
  111.     #5  "Line"
  112.     #6  "time used"      
  113.     #7  "Connection speeds"    
  114.     #8  "Registrations"  
  115.     #9  "Name                     Calls  Time"
  116.     #10    "Total"    
  117.     #11    Sessions to omit, comma separated. Can contain up to 12 sessions
  118.     #12    TEXT file signature    
  119. STR# 129 holds log prompts as follows:
  120.     #1  " Start "    
  121.     #2  " Command Line "  
  122.     #3  " Session Ended. "    
  123.     #4  " auto-registered Sess "
  124. STR# 130 holds paths & misc info as follows:
  125.     #1  Path to FC daily logs    
  126.     #2  Path of brief report file
  127.     #3  Name of brief report file
  128.     #4  Y/N Defaults [1] = MultiFinder, [2] = Automatic, [3] = Brief Report
  129.     #5  Special line
  130.  
  131. Version History:
  132.  
  133. Version 1.0 was released Oct. 22, 1991.
  134.  
  135. Version 1.0.1 corrected negative time figures which resulted from multiple "Session end" entries in the daily log. It was released Dec. 23, 1991.
  136.  
  137. Version 1.0.2 adds the ability to mark calls on a special line (configurable, stored in STR# 130 #5). This version was not released.
  138.